/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.uml_generator.bean;

import java.io.File;
import java.net.URL;

/**
 * Interface that allows to pass configuration information through the
 * generation process.
 */
public interface GenerationConfiguration
{
  /**
   * returns the name of the package that must contains the configuration files.
   * 
   * @return the name of the package that must contains the configuration files
   */
  public String getConfigurationPackage();



  /**
   * returns the {@link File} containing the xmi definition of the classes to
   * generate.
   * 
   * @return the {@link File} containing the xmi definition of the classes to
   *         generate
   */
  public File[] getXmiFiles();



  /**
   * returns the {@link File} containing the directory where the generated
   * sources must be written.
   * 
   * @return the {@link File} containing the directory where the generated
   *         sources must be written
   */
  public File getGeneratedSrcDir();



  /**
   * returns the {@link File} containing the directory where the generated
   * resources must be written.
   * 
   * @return the {@link File} containing the directory where the generated
   *         resources must be written
   */
  public File getGeneratedResourcesDir();



  /**
   * returns the {@link File} containing the directory where the persistent
   * sources must be written.
   * 
   * @return the {@link File} containing the directory where the persistent
   *         sources must be written
   */
  public File getSrcDir();



  /**
   * returns the {@link File} containing the directory where the persistent
   * resources must be written.
   * 
   * @return the {@link File} containing the directory where the persistent
   *         resources must be written
   */
  public File getResourcesDir();



  /**
   * returns the prefix to add to fields/tables and all element created in the
   * database.
   * 
   * @return the prefix to add to fields/tables and all element created in the
   *         database.
   */
  public String getDbElementPrefix();



  /**
   * returns the max size of an identifier length for the DB.
   * 
   * @return the max size of an identifier length for the DB
   */
  public int getMaxDbIdentifierLength();



  /**
   * returns the {@link URL} to the Jalopy configuration.
   * 
   * @return the {@link URL} to the Jalopy configuration or <code>null</code>
   *         if no code templates must be applied
   */
  public URL getJalopyConfiguration();



  /**
   * returns the arrays containing the locales to generate beside the default.
   * 
   * @return the arrays containing the locales to generate beside the default
   */
  public String[] getLocales();

}
